@pexip/mee-sdk
Enumerations
Interfaces
Type Aliases
Roster
Ƭ Roster: RosterUpdate["participants"]
RosterEntry
Ƭ RosterEntry: RosterUpdate["participants"][``"streams"``]
SocketManager
Ƭ SocketManager: ReturnType<typeof createSocketManager>
SocketSignals
Ƭ SocketSignals: typeof socketSignals
Variables
MAX_RECONNECT_ATTEMPTS
• Const MAX_RECONNECT_ATTEMPTS: 0
meeSignals
• Const meeSignals: Object
Type declaration
| Name | Type |
|---|---|
onRemoteStreams | Signal<MediaStream[]> |
onRosterUpdate | Signal<{ [k: string]: RosterEntry; }> |
pcMainSignals
• Const pcMainSignals: Pick<CorePeerConnectionSignals & Omit<PeerConnectionCommandSignals, "onReceiveIceCandidate"> & Required<PCOptionalsSignals>, "onError" | "onIceCandidate" | "onConnectionStateChange" | "onRemoteStreams" | "onOfferRequired" | "onReceiveAnswer" | "onReceiveOffer" | "onOffer" | "onOfferIgnored" | "onAnswer">
socketSignals
• Const socketSignals: Pick<Required<SocketSignals<MEEWebsocketMessageTypesUnion>>, "onConnecting" | "onConnected" | "onReconnecting" | "onReconnected" | "onDisconnected" | "onError" | "onMessage">
Functions
createMee
▸ createMee(args): Mee
Creates MEE wrapper for the given apiAddress and userID
Parameters
| Name | Type | Description |
|---|---|---|
args | Object | Provides necessary information like apiAddress and userId |
args.apiAddress | string | - |
args.userId | string | - |
Returns
Wrapper which encapsulates all interactions with MEE backend including WEBRTC
createToken
▸ createToken(userId, scopes?): string
Parameters
| Name | Type |
|---|---|
userId | string |
scopes | string[] |
Returns
string
setLogger
▸ setLogger(newLogger): void
Parameters
| Name | Type |
|---|---|
newLogger | Logger |
Returns
void